home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / programr / mhplus32.zip / HOWTORUN.TX_ / HOWTORUN.TX
Text File  |  1994-11-15  |  7KB  |  181 lines
  1.  
  2.               ** A BRIEF OVERVIEW OF **
  3.     ** HOW TO RUN MiniHelp Plus v3.21 **
  4.  
  5.  
  6. For a complete explanation of how to run MiniHelp Plus v3.21,
  7. consult the User's Manual and the online Help file,
  8. mhplus32.hlp.
  9.  
  10.  
  11. MiniHelp Plus v3.21 adds more functionality and ease of use
  12. to the "button bar" Windows shell that was introduced with
  13. the release of MiniHelp Plus v3.1.  Quite simply, if you can
  14. a) type, and b) click the mouse on a button, you are fully
  15. capable of writing your very own Windows Help Files.  And
  16. you can learn to do so in a very, very short time since the
  17. commands for MiniHelp Plus v3.21 are uncomplicated, easy
  18. to use, easy to learn, and fast.
  19.  
  20.  
  21. Below is a list of the buttons and some of the features of
  22. MiniHelp Plus v3.21.  The program has grown IMMENSELY
  23. since MiniHelp Plus v1.0, and quite a few of the features
  24. are new to MiniHelp Plus v3.21.
  25.  
  26.  
  27. ** COMPILE RTF **
  28. After you have typed in (and saved) your MiniHelp Plus v3.21
  29. source file, click on this button to create the RTF File, Help
  30. Project File (HPJ), Header File (HHH), and the bitmapped
  31. image INI file (mhp32bmp.dat).
  32.  
  33.  
  34. ** HELP COMPILER **
  35. Clicking on this button causes the Microsoft Help Compiler
  36. to begin compiling your Help file, using the HPJ file generated
  37. by MiniHelp Plus v3.21.
  38.  
  39.  
  40. ** MINIHELP HELP **
  41. The MiniHelp Plus v3.21 Help file is displayed when you click
  42. on this button on the button bar.  The information in this Help
  43. file will assist you with learning (and serve as a reference to)
  44. the commands of MiniHelp Plus v3.21 and tell you everything
  45. you need to know to create your first Help file using MiniHelp
  46. Plus v3.2.  It will also guide you through the syntax used to
  47. create your MiniHelp Plus v3.21 source file. Also, it will answer
  48. any questions you have on running MiniHelp Plus v3.21.
  49.  
  50.  
  51. ** CONFIGURE... **
  52. Clicking on this button brings up the dialog box where you
  53. configure MiniHelp Plus v3.21.  It is here where you define
  54. such things as the name of your current source file, the path
  55. and filename of your default ASCII text editor and which version
  56. of the Help Compiler you are using.  You can also select a
  57. few options which tell MiniHelp Plus v3.21 whether to load
  58. in the source file of the currently defined project when you
  59. launch your default text editor, whether to load the HHH, HPJ,
  60. and ERR files into your default text editor or Windows Notepad,
  61. and whether to display the Welcome/Reminder message box
  62. each time MiniHelp Plus v3.21 is started.
  63.  
  64.  
  65. ** VIEW RTF FILE **
  66. You can view the RTF file generated by MiniHelp Plus v3.21
  67. by clicking on this button.  The RTF file is loaded into Windows
  68. Write word processor for you to view/edit.  And MiniHelp Plus
  69. v3.2 also automatically takes care of clearing away the annoying
  70. "Convert, No Conversion, Cancel" message box that ALWAYS
  71. appears whenever you load Windows Write with a file not in
  72. the Write format.
  73.  
  74.  
  75. ** VIEW HPJ FILE **
  76. To view/edit the HPJ file generated by MiniHelp Plus v3.21,
  77. click on this button.
  78.  
  79.  
  80. ** ABOUT... **
  81. Clicking on this button displays the usual "ego" screen, telling
  82. you about MiniHelp Plus v3.21.
  83.  
  84.  
  85. ** TEXT EDITOR **
  86. To launch your default ASCII text editor, click on this button.
  87. Depending on how you have MiniHelp Plus v3.21 configured,
  88. either the text editor itself will load up ready for a new file
  89. from scratch, or pre-loaded with the currently configured
  90. MiniHelp Plus v3.21 source file.
  91.  
  92.  
  93. ** ERROR FILE **
  94. You can view the error file (ERR) output by the Help Compiler
  95. at your leisure by clicking on this button.  Depending on
  96. how you have MiniHelp Plus v3.21 configured, the ERR file 
  97. will open, pre-loaded into either your default text editor or
  98. Windows Notepad.  This file displays the errors encountered
  99. by the Help Compiler while buiding (compiling) your Help file.
  100.  
  101.  
  102. ** BUILD & TEST **
  103. Compiles the MiniHelp Plus source file, runs the Help Compiler,
  104. and displays the resultant Help file AUTOMATICALLY, all with
  105. the selection of one button. (A great time saver!)
  106.  
  107.  
  108. ** VIEW HELP **
  109. Your new-just-been-completed Help file can be viewed simply
  110. by clicking on this button.  Of course, if a serious error was
  111. encountered by the Help Compiler during the build, your Help
  112. file might not exist yet (even though you might think it does).
  113. For this reason, it is a GOOD idea to check your Error File
  114. right after compiling your Help file.  This way, if no Help file
  115. appears, you have a good idea of why.
  116.  
  117.  
  118. ** VIEW HEADER **
  119. There will be times when you will need to access the Header
  120. file generated by MiniHelp Plus v3.21.  When you do, simply
  121. click on this button and, depending on how you have MiniHelp
  122. Plus v3.2 configured, the Header file will be loaded into either
  123. your default text editor or Windows Notepad.  Why might you
  124. want to view it?  Some of the Help macros can only be invoked
  125. if you know the context-id of a topic.  That is what this file
  126. contains.  MiniHelp Plus v3.21 creates it when you compile the
  127. source file and lists the topics in your source file, assigning
  128. a unique number to each one (the context-id number).
  129.  
  130.  
  131. ** VIEW BITMAPS **
  132. If you have PROPERLY defined the bitmaps in your Help project
  133. by including them in your HPJ file with the .hpjbitmap command,
  134. clicking this button will display a dialog box listing all the valid
  135. bitmaps defined in your project.  From there, you either double-
  136. click on the filename you want to view or click once on the name
  137. of the file you want to view and click on the view button.  The
  138. selected file will be displayed for you to view/edit, preloaded
  139. into Windows Paintbrush.  (NOTE:  Only those files with the
  140. file extension of .BMP are listed, since at this time, only Windows
  141. Paintbrush is used to view the bitmapped image files.  Perhaps
  142. I will allow users to configure future versions of MiniHelp Plus
  143. to use the Paint editor of their choice, much like the way users
  144. can define the default text editor of their choice now.  But, for
  145. the time being, only the .BMP file format is supported so you
  146. will need to convert any image files to this format if you want
  147. to be able to use this feature.  I am also toying with the idea
  148. of allowing users who have a copy of SHED.EXE, Microsoft's
  149. Hot Spot Editor, to load those files into that program in a
  150. future release.)
  151.  
  152.  
  153. ** EXIT **
  154. Clicking on this button allows you to quit MiniHelp Plus v3.21.
  155. Just in case you pressed it by mistake, you are asked if you
  156. are sure you want to quit.  Click on YES if you do, and NO if
  157. you do not want to quit at this time.
  158.  
  159.  
  160. ** OTHER FEATURES **
  161.  
  162. ** STATUS BAR **
  163. MiniHelp Plus v3.21 now sports a status bar that tells you what
  164. your last action was in MiniHelp Plus v3.21.
  165.  
  166. ** ALWAYS ON TOP **
  167. Now, you can toggle whether MiniHelp Plus v3.21 is the topmost
  168. window on your screen by selecting this option from the system
  169. menu.  Default is on.  When it is on, the far right side of the
  170. status bar has the words "ON TOP" displayed.  If it is not on,
  171. nothing is displayed in this part of the status bar.
  172.  
  173. ** TITLE BAR **
  174. The title bar of the MiniHelp Plus v3.21 window now displays the
  175. name of the currently defined project to serve as a visual and
  176. constant reminder of the currently configured project.
  177.  
  178.  
  179. As I stated before, for complete information on running MiniHelp
  180. Plus v3.2, consult the User's Manual and the online Help files.
  181.